Skip to content

docs: clarify region requirement for S3-compatible endpoints#851

Merged
ved015 merged 1 commit into
supermemoryai:mainfrom
davidmyriel:myriel/s3-compatible
May 26, 2026
Merged

docs: clarify region requirement for S3-compatible endpoints#851
ved015 merged 1 commit into
supermemoryai:mainfrom
davidmyriel:myriel/s3-compatible

Conversation

@davidmyriel
Copy link
Copy Markdown
Contributor

Hey there! Small docs fix for the S3 connector.

The region field is marked required in the config table, but the S3-compatible examples (MinIO, R2, Spaces) never say what to put there. Since those services don't use AWS regions, users either guess an AWS region or get stuck wondering why the field is asking for something that doesn't apply to their setup.

This PR:

  • Adds a one-liner explaining that region: 'auto' works for S3-compatible endpoints (the value is still needed for request signing, but the service ignores it)
  • Updates the MinIO example to use auto instead of us-east-1
  • Annotates the R2 and Spaces endpoint lines with the same hint
  • Adds Tigris to the list of S3-compatible providers while I was in there — same endpoint pattern as the others

No code changes, no new pages, just making an existing doc a bit clearer. Happy to adjust wording if you'd rather keep the scope tighter.

Thanks for taking a look!

@graphite-app graphite-app Bot requested a review from Dhravya May 6, 2026 09:33
@ved015
Copy link
Copy Markdown
Member

ved015 commented May 6, 2026

Hi @davidmyriel, the PR looks good overall

I had one small suggestion around the wording for the region explanation. Instead of mentioning “or any non-empty value”, maybe we can make it a bit more precise with something like:

  • Use region: 'auto' for S3-compatible providers that do not expose AWS-style regions.
  • For providers like MinIO or R2, use region: 'auto'.

Rest of the changes look great

@ved015
Copy link
Copy Markdown
Member

ved015 commented May 23, 2026

@davidmyriel can you pls resolve the conflicts so that we can close this

- Add Tigris to the list of S3-compatible providers
- Note that region: 'auto' applies to MinIO, R2, and Tigris (these services
  don't expose AWS-style regions; the value is still required for request
  signing but the service ignores it)
- Update MinIO example to use region: 'auto'
- Add Tigris row to the endpoint values table

Addresses review feedback from @ved015.
@davidmyriel davidmyriel force-pushed the myriel/s3-compatible branch from aa4a60a to 3926808 Compare May 26, 2026 12:13
@davidmyriel
Copy link
Copy Markdown
Contributor Author

@ved015 Vedant, I'm very sorry for the delay. I just sent over the changes as requested. Thank you!

@ved015 ved015 merged commit b88de1e into supermemoryai:main May 26, 2026
2 checks passed
@ved015
Copy link
Copy Markdown
Member

ved015 commented May 26, 2026

@davidmyriel thank you for your contribution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants